<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>overviews</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >Metadata Crawler</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;overviews
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="overviews-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module overviews</h1><p class="nomargin-top"><span class="codelink"><a href="overviews-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#getoverview" class="summary-sig-name">getoverview</a>(<span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">outfile</span>,
        <span class="summary-sig-arg">width</span>,
        <span class="summary-sig-arg">format</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">stretch_type</span>,
        <span class="summary-sig-arg">*stretch_args</span>)</span><br />
      Generate overviews for imagery</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#getoverview">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="stretch"></a><span class="summary-sig-name">stretch</span>(<span class="summary-sig-arg">stretchType</span>,
        <span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">*args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#stretch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_stretch_NONE"></a><span class="summary-sig-name">_stretch_NONE</span>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">*args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_NONE">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_stretch_PERCENT"></a><span class="summary-sig-name">_stretch_PERCENT</span>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">low</span>,
        <span class="summary-sig-arg">high</span>,
        <span class="summary-sig-arg">*args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_PERCENT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_stretch_MINMAX"></a><span class="summary-sig-name">_stretch_MINMAX</span>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">*args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_MINMAX">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_stretch_STDDEV"></a><span class="summary-sig-name">_stretch_STDDEV</span>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">std</span>,
        <span class="summary-sig-arg">*args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_STDDEV">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_stretch_COLOURTABLE"></a><span class="summary-sig-name">_stretch_COLOURTABLE</span>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">clr</span>,
        <span class="summary-sig-arg">*args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLE">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_stretch_COLORTABLE"></a><span class="summary-sig-name">_stretch_COLORTABLE</span>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">clr</span>,
        <span class="summary-sig-arg">*args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLE">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="GetDataTypeRange"></a><span class="summary-sig-name">GetDataTypeRange</span>(<span class="summary-sig-arg">datatype</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#GetDataTypeRange">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#HistPercentileValue" class="summary-sig-name">HistPercentileValue</a>(<span class="summary-sig-arg">inhist</span>,
        <span class="summary-sig-arg">percent</span>,
        <span class="summary-sig-arg">binsize</span>,
        <span class="summary-sig-arg">lowerlimit</span>)</span><br />
      Returns the score at a given percentile relative to the distribution 
      given by inhist.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#HistPercentileValue">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#ParseColorLUT" class="summary-sig-name">ParseColorLUT</a>(<span class="summary-sig-arg">f</span>)</span><br />
      Open and parse a colour lookup table, stripping out comment characters...</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#ParseColorLUT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="ExpandedColorLUT"></a><span class="summary-sig-name">ExpandedColorLUT</span>(<span class="summary-sig-arg">f</span>,
        <span class="summary-sig-arg">nvals</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#ExpandedColorLUT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="getoverview"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getoverview</span>(<span class="sig-arg">ds</span>,
        <span class="sig-arg">outfile</span>,
        <span class="sig-arg">width</span>,
        <span class="sig-arg">format</span>,
        <span class="sig-arg">bands</span>,
        <span class="sig-arg">stretch_type</span>,
        <span class="sig-arg">*stretch_args</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#getoverview">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Generate overviews for imagery</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (GDALDataset) - a GDALDataset object</li>
        <li><strong class="pname"><code>outfile</code></strong> (string) - a filepath to the output overview image. If supplied, format is 
          determined from the file extension</li>
        <li><strong class="pname"><code>width</code></strong> (integer) - output image width</li>
        <li><strong class="pname"><code>format</code></strong> (string) - format to generate overview image, one of 
          ['JPG','PNG','GIF','BMP','TIF']. Not required if outfile is 
          supplied.</li>
        <li><strong class="pname"><code>bands</code></strong> (list) - list of band numbers (base 1) in processing order - e.g [3,2,1]</li>
        <li><strong class="pname"><code>stretch_type</code></strong> (string) - stretch to apply to overview image, one of 
          ['NONE','PERCENT','MINMAX','STDDEV','COLOURTABLE'].</li>
        <li><strong class="pname"><code>stretch_args</code></strong> (various) - args to pass to the stretch algorithms</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>filepath (if outfile is supplied)/binary image data (if outfile 
          is not supplied)</dd>
  </dl>
</td></tr></table>
</div>
<a name="HistPercentileValue"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">HistPercentileValue</span>(<span class="sig-arg">inhist</span>,
        <span class="sig-arg">percent</span>,
        <span class="sig-arg">binsize</span>,
        <span class="sig-arg">lowerlimit</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#HistPercentileValue">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the score at a given percentile relative to the distribution 
  given by inhist.</p>
  <p>Usage:   histpercentilevalue(inhist, percent, binsize,lowerlimit)</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="ParseColorLUT"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ParseColorLUT</span>(<span class="sig-arg">f</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#ParseColorLUT">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Open and parse a colour lookup table, stripping out comment characters
Lines must be space separated
Format is: pixel red green blue [optional alpha]
Pixel value may be a range (eg 15-20)
The following comment characters may be used '#' '//' ';' '/*'
Example:
         #value   R   G   B   A
          11-15   255 0   0   255 #(red)
          16      255 165 0   255 #(orange)
          18      255 255 0   255 #(yellow)
          19      0   255 0   255 /*(green)
          21      0   0   255 255 /*(blue)
          98      0   255 255 255 ;(cyan)
          99-255  160 32  240 255 ;(purple)           

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >Metadata Crawler</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Oct 07 14:35:45 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
